/*-----------------------------------------------------------------------------
	The contents of this file are subject to the Mozilla Public License
	Version 1.1 (the "License"); you may not use this file except in
	compliance with the License. You may obtain a copy of the License at
	http://www.mozilla.org/MPL/
	
	Software distributed under the License is distributed on an "AS IS"
	basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the
	License for the specific language governing rights and limitations
	under the License.
	
	The Original Code is Fever Framework code.
	
	The Initial Developer of the Original Code is Romain Ecarnot.
	Portions created by Initial Developer are Copyright (C) 2006
	the Initial Developer. All Rights Reserved.
	
	Contributor(s):
	
	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
-----------------------------------------------------------------------------*/

import fever.app.local.Localisation;
import fever.data.formatter.CurrencySymbolAlignType;
import fever.data.formatter.NumberFormatter;

/**
 * Formats a valid number as a currency value.
 * 
 * <p>As it extends {@link NumberFormatter} it can adjusts the decimal rounding and 
 * precision, the thousands separator.
 * 
 * <p>it uses {@code Localisation API} to retreive default language specification like : 
 * <ul>
 *   <li>the currency symbol to use</li>
 *   <li>the currency symbol alignement</li>
 * </ul>
 * 
 * However you can override these properties as you want.
 * 
 * @author Romain Ecarnot
 */
class fever.data.formatter.CurrencyFormatter extends NumberFormatter
{
	//-------------------------------------------------------------------------
	// Public Properties
	//-------------------------------------------------------------------------
	
	/** Symbol alignment ('left' or 'right'). */
	public var alignSymbol : String; 
	
	/** Currency symbol to use. ( default use Localisation API )*/
	public var currencySymbol : String;
	
	
	//-------------------------------------------------------------------------
	// Public API
	//-------------------------------------------------------------------------
	
	/**
	 * Constructor.
	 */
	public function CurrencyFormatter()
	{
		super();
		
		precision = 2;	}
	
	/**
	 * Format passed-in {@code value}.
	 * 
	 * @param value Number to format
	 * @return String
	 */
	public function format( value : Number ) : String
	{
		alignSymbol = Localisation.getResource( 'fever:common.currency-align' );
		if( !alignSymbol ) alignSymbol = 'left';
		
		currencySymbol = Localisation.getResource( 'fever:common.currency-symbol' );
		if( !currencySymbol ) currencySymbol = '$';
		
		var result = super.format( value );
		
		if( result == '' ) return '';
		
		switch( alignSymbol )
		{
			case CurrencySymbolAlignType.LEFT :
				result = currencySymbol + " " + result;
				break;
			case CurrencySymbolAlignType.RIGHT :
				result += ( " " + currencySymbol );	
				break;
			default : 
				error = 'Invalid currency symbol alignement type';
				return '';
		}
		
		return result;
	}
}